Class Objects.Room
Rooms
Functions
| Room:GetActive() | Determine whether the room is active or not |
| Room:GetColor() | Get the room's ambient light color. |
| Room:GetReverbType() | Get the room's reverb type. |
| Room:SetReverbType(new) | Set the room's reverb type. |
| Room:GetName() | Get the room's unique string identifier. |
| Room:SetName(name) | Set the room's name (its unique string identifier). |
| Room:GetFlag(flagID) | Get the room's specified flag value (true or false). |
| Room:SetFlag(flagID, the) | Set the room's specified flag value. |
| Room:IsTagPresent(tag) | Checks if specified tag is set for this room. |
Functions
- Room:GetActive()
-
Determine whether the room is active or not
Returns:
-
bool
true if the room is active
- Room:GetColor()
-
Get the room's ambient light color.
Returns:
-
Color
ambient light color of the room
- Room:GetReverbType()
-
Get the room's reverb type.
Returns:
-
RoomReverb
room's reverb type
- Room:SetReverbType(new)
-
Set the room's reverb type.
Parameters:
- new RoomReverb reverb type of the room
- Room:GetName()
-
Get the room's unique string identifier.
Returns:
-
string
the room's name
- Room:SetName(name)
-
Set the room's name (its unique string identifier).
Parameters:
- name string The room's new name
- Room:GetFlag(flagID)
-
Get the room's specified flag value (true or false).
Parameters:
- flagID RoomFlagID The room's flag ID
Returns:
-
bool
the room's specified flag value
- Room:SetFlag(flagID, the)
-
Set the room's specified flag value.
Parameters:
- flagID RoomFlagID The room's flag ID
- the bool room's new flag value
- Room:IsTagPresent(tag)
-
Checks if specified tag is set for this room.
Parameters:
- tag string A text tag to check (case sensitive)
Returns:
-
bool
true if tag is present, false if not